<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libconfini: Function Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">libconfini
   </div>
   <div id="projectbrief">Yet another INI parser</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="PageDoc"><div class="header">
  <div class="headertitle">
<div class="title">Function Overview </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Complete list of functions</p>
<p>Here follows the list of public functions available with <b>libconfini</b>. Almost each of them is independent, therefore if you are compiling the library you may decide to remove the functions listed below from the code according to your needs, with the only exceptions of <code><a class="el" href="confini_8c.html#a731857502fa7f8e31c4a024335a6d5d6" title="Compare two INI strings and check whether they match.">ini_string_match_ii()</a></code>, required by <code><a class="el" href="confini_8c.html#a76a050b341e311cc9bbb79b399691e12" title="Compare two INI arrays and check whether they match.">ini_array_match()</a></code> (you could still remove both though), and <code><a class="el" href="confini_8c.html#a25d648d387f6e8bc36e7965accfca63b" title="Parse and tokenize a buffer containing an INI file, then dispatch its content to a custom callback.">strip_ini_cache()</a></code>, required by both <code><a class="el" href="confini_8c.html#a7d5042d3044dfb5a34a6bfc5af3a882d" title="Parse an INI file and dispatch its content to a custom callback using a FILE structure as argument.">load_ini_file()</a></code> and <code><a class="el" href="confini_8c.html#a54be108d26619db3066ce1c000dc8a17" title="Parse an INI file and dispatch its content to a custom callback using a path as argument.">load_ini_path()</a></code> (you could remove these three functions altogether as well, but you would make the library virtually useless).</p>
<dl>
<dt><code><a class="el" href="confini_8c.html#a25d648d387f6e8bc36e7965accfca63b" title="Parse and tokenize a buffer containing an INI file, then dispatch its content to a custom callback.">strip_ini_cache()</a></code></dt>
<dd><p class="startdd">Parse and tokenize a buffer containing an INI file, then dispatch its content to a custom callback. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a7d5042d3044dfb5a34a6bfc5af3a882d" title="Parse an INI file and dispatch its content to a custom callback using a FILE structure as argument.">load_ini_file()</a></code></dt>
<dd><p class="startdd">Parse an INI file and dispatch its content to a custom callback using a <code>FILE</code> structure as argument. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a54be108d26619db3066ce1c000dc8a17" title="Parse an INI file and dispatch its content to a custom callback using a path as argument.">load_ini_path()</a></code></dt>
<dd><p class="startdd">Parse an INI file and dispatch its content to a custom callback using a path as argument. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a8bb35677b6e7c201eb1fe83efee99d9a" title="Compare two simple strings and check whether they match.">ini_string_match_ss()</a></code></dt>
<dd><p class="startdd">Compare two simple strings and check whether they match. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a5773ae8cbe4ce15737dcece84b362fa0" title="Compare a simple string and an INI string and and check whether they match.">ini_string_match_si()</a></code></dt>
<dd><p class="startdd">Compare a simple string and an INI string and and check whether they match. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a731857502fa7f8e31c4a024335a6d5d6" title="Compare two INI strings and check whether they match.">ini_string_match_ii()</a></code></dt>
<dd><p class="startdd">Compare two INI strings and check whether they match. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a76a050b341e311cc9bbb79b399691e12" title="Compare two INI arrays and check whether they match.">ini_array_match()</a></code></dt>
<dd><p class="startdd">Compare two INI arrays and check whether they match. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#ac55f3fab95f697ac5058533df100fc11" title="Unescape \&#39;, \&quot;, and \\ and remove all unescaped quotes (when single/double quotes are considered met...">ini_unquote()</a></code></dt>
<dd><p class="startdd">Unescape <code>\'</code>, <code>\&quot;</code>, and <code>\\</code> and remove all unescaped quotes (when single/double quotes are considered metacharacters in respect to the format given) </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#ab4e3d48f0eb0438ba0c84fc77e362aa3" title="Unescape \&#39;, \&quot;, and \\ and remove all unescaped quotes (when single/double quotes are considered met...">ini_string_parse()</a></code></dt>
<dd><p class="startdd">Unescape <code>\'</code>, <code>\&quot;</code>, and <code>\\</code> and remove all unescaped quotes (when single/double quotes are considered metacharacters in respect to the format given); if the format allows it, sequences of one or more spaces out of quotes will be collapsed. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a312803fa24be2d7f164f3041fbfa6865" title="Get the length of a stringified INI array in number of members.">ini_array_get_length()</a></code></dt>
<dd><p class="startdd">Get the length of a stringified INI array in number of members. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a414c3b92adf45dbb966df1606b71ccdf" title="Call a custom function for each member of a stringified INI array, without modifying the content of t...">ini_array_foreach()</a></code></dt>
<dd><p class="startdd">Call a custom function for each member of a stringified INI array, without modifying the content of the buffer &ndash; useful for read-only (<code>const</code>) stringified arrays. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a6ca567ad863caef4609f8def7de0401a" title="Shift the location pointed by ini_strptr to the next member of the INI array (without modifying the c...">ini_array_shift()</a></code></dt>
<dd><p class="startdd">Shift the location pointed by <code>ini_strptr</code> to the next member of the INI array (without modifying the content of the buffer), or to <code>NULL</code> if the INI array has no more members &ndash; useful for read-only (<code>const</code>) stringified arrays. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#aa0721fcae5f04e5a9edd485dc1ddd2fa" title="Compress the distribution of the data in a stringified INI array by removing all the white spaces tha...">ini_array_collapse()</a></code></dt>
<dd><p class="startdd">Compress the distribution of the data in a stringified INI array by removing all the white spaces that surround its delimiters, empty quotes, collapsable spaces, etc. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a75809c0e952d9f9e14333e085ba6b910" title="Replace the first delimiter found (together with the spaces that surround it) with \0">ini_array_break()</a></code></dt>
<dd><p class="startdd">Replace the first delimiter found (together with the spaces that surround it) with <code>\0</code> </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a2b34dc032fc37dda829dadf80bf34d26" title="Replace the first delimiter found (together with the spaces that surround it) with \0,...">ini_array_release()</a></code></dt>
<dd><p class="startdd">Replace the first delimiter found (together with the spaces that surround it) with <code>\0</code>, then shifts the location pointed by <code>ini_strptr</code> to the next member of the INI array, or to <code>NULL</code> if the INI array has no more members. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a04acd6a01a6a78810e7aab8e02923218" title="Split a stringified INI array into NUL-separated members and call a custom function for each member.">ini_array_split()</a></code></dt>
<dd><p class="startdd">Split a stringified INI array into NUL-separated members and call a custom function for each member. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a3a6eb3b79a88304864341075240ee412" title="Set the value to be to be assigned to implicit keys.">ini_global_set_implicit_value()</a></code></dt>
<dd><p class="startdd">Set the value to be to be assigned to implicit keys. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a02bf5a1299ffb85fbd2f087cffbc1db8" title="Calculate the IniFormatNum of an IniFormat.">ini_fton()</a></code></dt>
<dd><p class="startdd">Calculate the <a class="el" href="confini_8h.html#a47a6a31dd11db39ac287147955733511" title="The unique ID of an INI format (24-bit maximum)">IniFormatNum</a> of an <a class="el" href="structIniFormat.html" title="24-bit bitfield representing the format of an INI file (INI dialect)">IniFormat</a>. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#ab4f3def0b84486ca2154673f339763fa" title="Construct a new IniFormat according to an IniFormatNum.">ini_ntof()</a></code></dt>
<dd><p class="startdd">Construct a new <a class="el" href="structIniFormat.html" title="24-bit bitfield representing the format of an INI file (INI dialect)">IniFormat</a> according to an <a class="el" href="confini_8h.html#a47a6a31dd11db39ac287147955733511" title="The unique ID of an INI format (24-bit maximum)">IniFormatNum</a>. </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#ac43249a99e97f1d669a80c22a3e42564" title="Check whether a simple string matches one of the booleans listed in the private constant INI_BOOLEANS...">ini_get_bool()</a></code></dt>
<dd><p class="startdd">Check whether a simple string matches one of the booleans listed in the private constant <a class="el" href="confini_8c.html#afdb9fd02d693536253da07f0f468aaef" title="A list of possible string representations of boolean pairs.">INI_BOOLEANS</a> (case-insensitive) </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a5d3460168636cfdffc6fb76be7c9b6b3" title="Check whether an INI string matches one of the booleans listed in the private constant INI_BOOLEANS (...">ini_get_bool_i()</a></code></dt>
<dd><p class="startdd">Check whether an INI string matches one of the booleans listed in the private constant <a class="el" href="confini_8c.html#afdb9fd02d693536253da07f0f468aaef" title="A list of possible string representations of boolean pairs.">INI_BOOLEANS</a> (case-insensitive) </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a5b6bebfc01f8b23f69a2a2e602e91521" title="Pointer to atoi()">ini_get_int()</a></code></dt>
<dd><p class="startdd">Pointer to <a href="http://www.gnu.org/software/libc/manual/html_node/Parsing-of-Integers.html#index-atoi"><code>atoi()</code></a> </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#a05042d2551ab1c9402ab7223547c0777" title="Pointer to atol()">ini_get_lint()</a></code></dt>
<dd><p class="startdd">Pointer to <a href="http://www.gnu.org/software/libc/manual/html_node/Parsing-of-Integers.html#index-atol"><code>atol()</code></a> </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#aaf3640e3632b10bf8dd2e852a7d82630" title="Pointer to atoll()">ini_get_llint()</a></code></dt>
<dd><p class="startdd">Pointer to <a href="http://www.gnu.org/software/libc/manual/html_node/Parsing-of-Integers.html#index-atoll"><code>atoll()</code></a> </p>
<p class="enddd"></p>
</dd>
<dt><code><a class="el" href="confini_8c.html#ac7aafdf3e7becda36ebe4e20f0f7438d" title="Pointer to atof()">ini_get_double()</a></code></dt>
<dd><p class="startdd">Pointer to <a href="http://www.gnu.org/software/libc/manual/html_node/Parsing-of-Integers.html#index-atof"><code>atof()</code></a> </p>
<p class="enddd"></p>
</dd>
</dl>
</div></div><!-- contents -->
</div><!-- PageDoc -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
